home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2004 #2 / Amiga Plus CD - 2004 - No. 02.iso / AmigaPlus / Tools / Anwendungen / CManager / Developer / Autodoc / CManager_mcc.doc < prev   
Encoding:
Text File  |  2004-01-31  |  10.8 KB  |  524 lines
  1. TABLE OF CONTENTS
  2.  
  3. CManager.mcc/CManager.mcc
  4. CManager.mcc/MUIA_CManager_AppDoubleClick
  5. CManager.mcc/MUIA_CManager_Changed
  6. CManager.mcc/MUIA_CManager_CMData
  7. CManager.mcc/MUIA_CManager_DoubleClickObject
  8. CManager.mcc/MUIA_CManager_HideChat
  9. CManager.mcc/MUIA_CManager_HideFTP
  10. CManager.mcc/MUIA_CManager_HideTelnet
  11. CManager.mcc/MUIA_CManager_HideUsers
  12. CManager.mcc/MUIA_CManager_HideWWW
  13. CManager.mcc/MUIA_CManager_ListObject
  14. CManager.mcc/MUIA_CManager_NoBar
  15. CManager.mcc/MUIA_CManager_NoGroups
  16. CManager.mcc/MUIA_CManager_NoMenu
  17. CManager.mcc/MUIA_CManager_Path
  18. CManager.mcc/MUIA_CManager_Prefs
  19. CManager.mcc/MUIA_CManager_ButtonsBar
  20. CManager.mcc/MUIA_CManager_TreeObject
  21. CManager.mcc/MUIM_CManager_AddEntry
  22. CManager.mcc/MUIM_CManager_Cleanup
  23. CManager.mcc/MUIM_CManager_DoubleClick
  24. CManager.mcc/MUIM_CManager_EditSelected
  25. CManager.mcc/MUIM_CManager_Export
  26. CManager.mcc/MUIM_CManager_Import
  27. CManager.mcc/MUIM_CManager_LoadData
  28. CManager.mcc/MUIM_CManager_Login
  29. CManager.mcc/MUIM_CManager_LoginWindow
  30. CManager.mcc/MUIM_CManager_PrefsWindow
  31. CManager.mcc/MUIM_CManager_Reload
  32. CManager.mcc/MUIM_CManager_SaveData
  33. CManager.mcc/MUIM_CManager_Search
  34. CManager.mcc/CManager.mcc
  35.  
  36. CManager.mcc/MUIA_CManager_AppDoubleClick
  37.  
  38.    NAME
  39.     MUIA_CManager_AppDoubleClick -- [IS..], struct Hook *
  40.  
  41.    FUNCTION
  42.     Here you may define a hook to be called anytime the user
  43.     double-clicks on an entry.
  44.  
  45.     It is called with arguments:
  46.         REG(a0) struct Hook *hook - the hook in itself
  47.         REG(a2) Object *obj - the CManager Object *
  48.         REG(a1) struct CMUser *entry - result from double click
  49.  
  50.     Check entry->Type to switch among different types of entries.
  51.  
  52.     Default NULL .
  53.  
  54.    SEE
  55.     MUIA_CManager_DoubleClickObject
  56.  
  57. CManager.mcc/MUIA_CManager_Changed
  58.  
  59.    NAME
  60.     MUIA_CManager_Changed -- [..GN], BOOL
  61.  
  62.    FUNCTION
  63.     It indicates that data has been modified since last saving.
  64.  
  65. CManager.mcc/MUIA_CManager_CMdata
  66.  
  67.    NAME
  68.     MUIA_CManager_CMdata -- [..G.], struct CMData *
  69.  
  70.    FUNCTION
  71.     The data the object is currently handling.
  72.  
  73. CManager.mcc/MUIA_CManager_DoubleClickObject
  74.  
  75.    NAME
  76.     MUIA_CManager_DoubleClickObject -- [IS..], Object *
  77.  
  78.    FUNCTION
  79.     If you are a smart MUI programmer, you use it instead of
  80.     MUIA_CManager_AppDoubleClick, because of hooks sucks.
  81.  
  82.     Anytime the user double clicks an an entry, the CManager
  83.     object will do a
  84.  
  85.     DoMethod(DoubleClickObject,MUIM_CManager_DoubleClick,entry);
  86.  
  87.     where entry is the entry the user double-clicked on.
  88.  
  89.     Default NULL .
  90.  
  91.    SEE
  92.     MUIA_CManager_AppDoubleClick
  93.  
  94. CManager.mcc/MUIA_CManager_HideChat
  95.  
  96.    NAME
  97.     MUIA_CManager_HideChat -- [I...], BOOL
  98.  
  99.    FUNCTION
  100.     Pass it as TRUE at init time to hide Chat data.
  101.  
  102.     Default FALSE .
  103.  
  104.    SEE
  105.     MUIA_CManager_HideFTP
  106.     MUIA_CManager_HideTelnet
  107.     MUIA_CManager_HideUsers
  108.     MUIA_CManager_HideWWW
  109.  
  110. CManager.mcc/MUIA_CManager_HideFTP
  111.  
  112.    NAME
  113.     MUIA_CManager_HideFTP -- [I...], BOOL
  114.  
  115.    FUNCTION
  116.     Pass it as TRUE at init time to hide FTP data.
  117.  
  118.     Default FALSE .
  119.  
  120.    SEE
  121.     MUIA_CManager_HideChat
  122.     MUIA_CManager_HideTelnet
  123.     MUIA_CManager_HideUsers
  124.     MUIA_CManager_HideWWW
  125.  
  126. CManager.mcc/MUIA_CManager_HideTelnet
  127.  
  128.    NAME
  129.     MUIA_CManager_HideTelnet -- [I...], BOOL
  130.  
  131.    FUNCTION
  132.     Pass it as TRUE at init time to hide Telnet data.
  133.  
  134.     Default FALSE .
  135.  
  136.    SEE
  137.     MUIA_CManager_HideChat
  138.     MUIA_CManager_HideFTP
  139.     MUIA_CManager_HideUsers
  140.     MUIA_CManager_HideWWW
  141.  
  142. CManager.mcc/MUIA_CManager_HideUsers
  143.  
  144.    NAME
  145.     MUIA_CManager_HideUsers -- [I...], BOOL
  146.  
  147.    FUNCTION
  148.     Pass it as TRUE at init time to hide Users data.
  149.  
  150.     Default FALSE .
  151.  
  152.    SEE
  153.     MUIA_CManager_HideChat
  154.     MUIA_CManager_HideFTP
  155.     MUIA_CManager_HideTelnet
  156.     MUIA_CManager_HideWWW
  157.  
  158. CManager.mcc/MUIA_CManager_HideWWW
  159.  
  160.    NAME
  161.     MUIA_CManager_HideWWW -- [I...], BOOL
  162.  
  163.    FUNCTION
  164.     Pass it as TRUE at init time to hide WWW data.
  165.  
  166.     Default FALSE .
  167.  
  168.    SEE
  169.     MUIA_CManager_HideChat
  170.     MUIA_CManager_HideFTP
  171.     MUIA_CManager_HideTelnet
  172.     MUIA_CManager_HideUsers
  173.  
  174. CManager.mcc/MUIA_CManager_ListObject
  175.  
  176.    NAME
  177.     MUIA_CManager_ListObject -- [..G.], Object *
  178.  
  179.    FUNCTION
  180.     PRIVATE!
  181.  
  182. CManager.mcc/MUIA_CManager_NoBar
  183.  
  184.    NAME
  185.     MUIA_CManager_NoBar -- [ISGN], BOOL
  186.  
  187.    FUNCTION
  188.     Switches on/off the buttons bar. If TRUE at init time, the
  189.     buttons bar is not created at all, so that it can't be set.
  190.  
  191.     Default FALSE .
  192.  
  193.    SEE
  194.     MUIA_CManager_NoGroups
  195.  
  196. CManager.mcc/MUIA_CManager_NoGroups
  197.  
  198.    NAME
  199.     MUIA_CManager_NoGroups -- [ISGN], BOOL
  200.  
  201.    FUNCTION
  202.     Switches on/off the group controls gadgets.
  203.  
  204.     Default FALSE .
  205.  
  206.    SEE
  207.     MUIA_CManager_NoBar
  208.  
  209. CManager.mcc/MUIA_CManager_NoMenu
  210.  
  211.    NAME
  212.     MUIA_CManager_NoMenu -- [ISGN], BOOL
  213.  
  214.    FUNCTION
  215.     Switches on/off the "Actions context menu" of the entries
  216.     list.
  217.  
  218.     Default FALSE .
  219.  
  220. CManager.mcc/MUIA_CManager_Path
  221.  
  222.    NAME
  223.     MUIA_CManager_Path -- [..G.], STRPTR
  224.  
  225.    FUNCTION
  226.     Use it to get the complete path to the
  227.     CManager application.
  228.  
  229. CManager.mcc/MUIA_CManager_Prefs
  230.  
  231.    NAME
  232.     MUIA_CManager_Prefs -- [..G.], struct CMPrefs *
  233.  
  234.    FUNCTION
  235.     Use it to get the object preferences.
  236.     Note that they are READ ONLY!
  237.  
  238. CManager.mcc/MUIA_CManager_ButtonsBar
  239.  
  240.    NAME
  241.     MUIA_CManager_ButtonsBar -- [..G.], Object *
  242.  
  243.    FUNCTION
  244.     Get the buttons bar object. Be prepared to get a NULL.
  245.  
  246.     Only needed in the drag methods of a CManager.mcc
  247.     subclass. F.e.:
  248.  
  249.     ULONG mDragQuery(struct IClass *cl,Object *obj,struct MUIP_DragDrop *msg)
  250.     {
  251.         Object *sb = NULL;
  252.  
  253.         get(obj,MUIA_CManager_ButtonsBar,&sb);
  254.         if (msg->obj==sb) return DoSuperMethodA(cl,obj,(Msg)msg);
  255.         ...
  256.     }
  257.  
  258.     ULONG mDragDrop(struct IClass *cl,Object *obj,struct MUIP_DragDrop *msg)
  259.     {
  260.         Object *sb = NULL;
  261.  
  262.         get(obj,MUIA_CManager_ButtonsBar,&sb);
  263.         if (msg->obj==sb) return DoSuperMethodA(cl,obj,(Msg)msg);
  264.         ...
  265.     }
  266.  
  267. CManager.mcc/MUIA_CManager_TreeObject
  268.  
  269.    NAME
  270.     MUIA_CManager_TreeObject -- [..G.], Object *
  271.  
  272.    FUNCTION
  273.     PRIVATE!
  274.  
  275. CManager.mcc.mcc/MUIM_CManager_AddEntry
  276.  
  277.     NAME
  278.      MUIM_CManager_AddEntry
  279.  
  280.     SYNOPSIS
  281.      DoMethod(obj,MUIM_CManager_AddEntry,struct CMUser *entry,ULONG flags);
  282.  
  283.      Add an entry to the CMData.
  284.  
  285.      The entry is added to the current group if
  286.      MUIV_CManager_AddEntry_CurrentGroup is specified.
  287.  
  288.     RESULT
  289.      none
  290.  
  291. CManager.mcc.mcc/MUIM_CManager_Cleanup
  292.  
  293.     NAME
  294.      MUIM_CManager_Cleanup
  295.  
  296.     SYNOPSIS
  297.      DoMethod(obj,MUIM_CManager_Cleanup);
  298.  
  299.      Closes all the CManager windows currently opened.
  300.  
  301.     RESULT
  302.      none
  303.  
  304. CManager.mcc.mcc/MUIM_CManager_DoubleClick
  305.  
  306.     NAME
  307.      MUIM_CManager_DoubleClick
  308.  
  309.     SYNOPSIS
  310.      DoMethod(DoubleClickObject,MUIM_CManager_DoubleClick,struct CMUser *entry);
  311.  
  312.      It is not a CManager method, but is is invoked on the object
  313.      specified in MUIA_CManager_DoubleClickObject any time the
  314.      user double-clicks on an entry.
  315.  
  316.     RESULT
  317.      none
  318.  
  319.     SEE
  320.      MUIA_CManager_DoubleClickObject
  321.  
  322. CManager.mcc.mcc/MUIM_CManager_EditSelected
  323.  
  324.     NAME
  325.      MUIM_CManager_EditSelected
  326.  
  327.     SYNOPSIS
  328.      DoMethod(obj,MUIM_CManager_EditSelected);
  329.  
  330.      Opens the edit windows for the selected entries.
  331.  
  332.     RESULT
  333.      none
  334.  
  335. CManager.mcc.mcc/MUIM_CManager_Export
  336.  
  337.     NAME
  338.      MUIM_CManager_Export
  339.  
  340.     SYNOPSIS
  341.      DoMethod(obj,MUIM_CManager_Export,ULONG Type,STRPTR File,ULONG Flags);
  342.  
  343.      Exports the current data to a file.
  344.  
  345.      Type is one of:
  346.  
  347.      - MUIV_CManager_Export_HTML_URLs
  348.        Exports Users URLs as HTML
  349.  
  350.      - MUIV_CManager_Export_HTML_WWW
  351.        Exports WWW sites URLs as HTML
  352.  
  353.      - MUIV_CManager_Export_HTML_FTP
  354.        Exports FTP sites URLs as HTML
  355.  
  356.      - MUIV_CManager_Export_CSV_Users
  357.        Exports Users in CSV format
  358.  
  359.      - MUIV_CManager_Export_CSVFullOE_Users
  360.        Exports Users in CSV format so that Outlook Express
  361.        may import it
  362.  
  363.      - MUIV_CManager_Export_YAM,
  364.        Exports Users in YAM address book format
  365.  
  366.      - MUIV_CManager_Export_AWeb,
  367.        Exports Users in AWeb hotlist format
  368.  
  369.      - MUIV_CManager_Export_IBrowse,
  370.        Exports Users in IBrowser hotlist format
  371.  
  372.      - MUIV_CManager_Export_Netscape
  373.        Exports Users so that Internet Explorer may
  374.        import it as a HTML file
  375.  
  376.      File is the file to write.
  377.  
  378.      Flags is a combination of:
  379.  
  380.      - MUIV_CManager_Export_NoHead
  381.        Do not write HTML head for HTML format Type.
  382.  
  383.     RESULT
  384.      none
  385.  
  386. CManager.mcc.mcc/MUIM_CManager_Import
  387.  
  388.     NAME
  389.      MUIM_CManager_Import
  390.  
  391.     SYNOPSIS
  392.      DoMethod(obj,MUIM_CManager_Import,ULONG Type,STRPTR File,ULONG Flags);
  393.  
  394.      Import datas from a file.
  395.  
  396.      Type is one of:
  397.      - MUIV_CManager_Import_Voyager
  398.      - MUIV_CManager_Import_IB
  399.      - MUIV_CManager_Import_AWeb
  400.      - MUIV_CManager_Import_Netscape
  401.      - MUIV_CManager_Import_Users_CSV
  402.      - MUIV_CManager_Import_Users_CSVFullOE
  403.      - MUIV_CManager_Import_AmFTP
  404.      - MUIV_CManager_Import_THOR
  405.      - MUIV_CManager_Import_MD
  406.      - MUIV_CManager_Import_YAM
  407.      - MUIV_CManager_Import_PINT
  408.      - MUIV_CManager_Import_GoodNews
  409.      - MUIV_CManager_Import_STRICQ
  410.      - MUIV_CManager_Import_OldSTFax
  411.      - MUIV_CManager_Import_STFax
  412.      - MUIV_CManager_Import_AmIRC
  413.      - MUIV_CManager_Import_DOpusFTP
  414.      - MUIV_CManager_Import_DFA
  415.  
  416.      File is the file to read.
  417.  
  418.      Flags is a combination of:
  419.  
  420.      - MUIV_CManager_Import_Filter
  421.        Avoid duplicate entries.
  422.  
  423.     RESULT
  424.      none
  425.  
  426. CManager.mcc.mcc/MUIM_CManager_LoadData
  427.  
  428.     NAME
  429.      MUIM_CManager_LoadData
  430.  
  431.     SYNOPSIS
  432.      DoMethod(MUIM_CManager_LoadData,STRPTR User,STRPTR Path);
  433.  
  434.      Load CMData in the CM object. Note that you must invoke this
  435.      method to load something in a CManager.mcc object.
  436.  
  437.      If User is specified, that User is logged an its data are
  438.      opened.
  439.  
  440.      If User is not specified, Path is used.
  441.  
  442.     RESULT
  443.      none
  444.  
  445. CManager.mcc.mcc/MUIM_CManager_Login
  446.  
  447.     NAME
  448.      MUIM_CManager_Login
  449.  
  450.     SYNOPSIS
  451.      DoMethod(MUIM_CManager_Login,STRPTR User);
  452.  
  453.      Login User in Genesis and opens its data.
  454.  
  455.     RESULT
  456.      none
  457.  
  458. CManager.mcc.mcc/MUIM_CManager_LoginWindow
  459.  
  460.     NAME
  461.      MUIM_CManager_LoginWindow
  462.  
  463.     SYNOPSIS
  464.      DoMethod(MUIM_CManager_LoginWindow);
  465.  
  466.      Opens the login window.
  467.  
  468.     RESULT
  469.      none
  470.  
  471. CManager.mcc.mcc/MUIM_CManager_PrefsWindow
  472.  
  473.     NAME
  474.      MUIM_CManager_PrefsWindow
  475.  
  476.     SYNOPSIS
  477.      DoMethod(MUIM_CManager_PrefsWindow,ULONG page);
  478.  
  479.      Opens the preferences window and go to page.
  480.  
  481.     RESULT
  482.      none
  483.  
  484. CManager.mcc.mcc/MUIM_CManager_Reload
  485.  
  486.     NAME
  487.      MUIM_CManager_Reload
  488.  
  489.     SYNOPSIS
  490.      DoMethod(MUIM_CManager_Reload);
  491.  
  492.      Reload data.
  493.  
  494.     RESULT
  495.      none
  496.  
  497. CManager.mcc.mcc/MUIM_CManager_SaveData
  498.  
  499.     NAME
  500.      MUIM_CManager_SaveData
  501.  
  502.     SYNOPSIS
  503.      DoMethod(MUIM_CManager_SaveData,STRPTR Path);
  504.  
  505.      Saves the current data.
  506.  
  507.      Path may be NULL to save data to the current data path.
  508.  
  509.     RESULT
  510.      none
  511.  
  512. CManager.mcc.mcc/MUIM_CManager_Search
  513.  
  514.     NAME
  515.      MUIM_CManager_Search
  516.  
  517.     SYNOPSIS
  518.      DoMethod(MUIM_CManager_Search);
  519.  
  520.      Open the search window.
  521.  
  522.     RESULT
  523.      none
  524.